Skip to content

luno-python: add PyPI description and update README badges#80

Merged
echarrod merged 6 commits intomainfrom
echarrod-pypi-description-badges
Apr 8, 2026
Merged

luno-python: add PyPI description and update README badges#80
echarrod merged 6 commits intomainfrom
echarrod-pypi-description-badges

Conversation

@echarrod
Copy link
Copy Markdown
Contributor

@echarrod echarrod commented Apr 7, 2026 •
edited by coderabbitai bot
Loading

Summary

  • Add long_description to setup.py reading from README.md so PyPI renders the project description instead of the placeholder message
  • Update README badges: replace broken Travis CI badge with GitHub Actions, add PyPI version, Python versions, and MIT licence badges
  • Add link to examples/ folder after the code snippet
  • Fix bandit pre-commit hook: remove unknown test ID B107 from pyproject.toml skips

Summary by CodeRabbit

Release Notes

  • Documentation

    • Updated README with PyPI and licence badges
    • Replaced CI badge with GitHub Actions
    • Added reference to examples folder for additional usage guidance

  • Chores

    • Improved package metadata and description on PyPI
    • Adjusted security tooling configuration

@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Apr 7, 2026 •
edited
Loading

Warning

Rate limit exceeded

@echarrod has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 17 minutes and 31 seconds before requesting another review.

Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 17 minutes and 31 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 94b8f122-96d7-419e-a68d-b3e8bbec6dd0

📥 Commits

Reviewing files that changed from the base of the PR and between 59e08db and 488c815.

📒 Files selected for processing (3)
  • .github/workflows/test.yml
  • README.md
  • setup.py
📝 Walkthrough

Walkthrough

The pull request updates documentation and packaging metadata: README.md was retitled from “Luno API” to “Luno Python SDK”, the Travis CI badge was replaced with a GitHub Actions “Run Tests” badge, PyPI and supported Python version badges plus an MIT license badge were added, and a note pointing to the ./examples folder was appended. setup.py now uses Path(...).read_text(encoding="utf-8") to populate long_description and sets long_description_content_type to text/markdown; the package description string was also adjusted. pyproject.toml removed the Bandit skip rule B107.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 A tiny hop for README bright,
New badges gleam in testing light,
setup reads words with careful care,
Bandit watches — I twitch my ear,
Examples beckon—come and share! 🥕

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately and concisely summarises the main changes: adding PyPI description metadata to setup.py and updating README badges.
Description check ✅ Passed The description is directly related to the changeset, providing clear details about each modification across README.md, setup.py, and pyproject.toml.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch echarrod-pypi-description-badges

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

coderabbitai[bot]
coderabbitai bot reviewed Apr 7, 2026
View reviewed changes
Copy link
Copy Markdown

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.md`:
- Line 8: The license badge link in the README uses the old branch name "master"
in the URL; update the markdown badge URL by replacing "blob/master/LICENSE.txt"
with "blob/main/LICENSE.txt" in the badge line (the [![License: MIT](...)](...)
markdown) so the badge points to the repository's main branch.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 88b85222-95ab-473c-a4d3-a6e193a501f8

📥 Commits

Reviewing files that changed from the base of the PR and between 002cdde and 97b7163.

📒 Files selected for processing (3)
  • README.md
  • pyproject.toml
  • setup.py
💤 Files with no reviewable changes (1)
  • pyproject.toml

Comment thread README.md Outdated
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud bot commented Apr 7, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

echarrod
echarrod commented Apr 8, 2026
View reviewed changes
Comment thread README.md
@echarrod echarrod merged commit ed3a8d8 into main Apr 8, 2026
8 checks passed
@echarrod echarrod deleted the echarrod-pypi-description-badges branch April 8, 2026 09:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

@RieshBissessur RieshBissessur RieshBissessur approved these changes

@arcturial arcturial Awaiting requested review from arcturial

@andrewwormald andrewwormald Awaiting requested review from andrewwormald

@pkachelhoffer pkachelhoffer Awaiting requested review from pkachelhoffer

@rjansen-go rjansen-go Awaiting requested review from rjansen-go

@jrkilloran jrkilloran Awaiting requested review from jrkilloran

@nventer1 nventer1 Awaiting requested review from nventer1

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@echarrod @RieshBissessur